<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - org.brophy.js.util</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/org.brophy.js.ajax.html">org.brophy.js.ajax</a></li>
	
	<li><a href="../symbols/org.brophy.js.ajax.ReplyManager.html">org.brophy.js.ajax.ReplyManager</a></li>
	
	<li><a href="../symbols/org.brophy.js.array.html">org.brophy.js.array</a></li>
	
	<li><a href="../symbols/org.brophy.js.constant.html">org.brophy.js.constant</a></li>
	
	<li><a href="../symbols/org.brophy.js.drag.html">org.brophy.js.drag</a></li>
	
	<li><a href="../symbols/org.brophy.js.drag.Dragger.html">org.brophy.js.drag.Dragger</a></li>
	
	<li><a href="../symbols/org.brophy.js.event.html">org.brophy.js.event</a></li>
	
	<li><a href="../symbols/org.brophy.js.select.html">org.brophy.js.select</a></li>
	
	<li><a href="../symbols/org.brophy.js.util.html">org.brophy.js.util</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Namespace org.brophy.js.util
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
			
				
Utilities namespace in the org.brophy.js JavaScript library
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/D__matt_Computer_JavaScript_orgbrophyjs_trunk_org_brophy_js_util.js.html">util.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class org.brophy.js.util.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/org.brophy.js.util.html#constructor">org.brophy.js.util</a></b>
							</div>
							<div class="description">Utilities namespace in the org.brophy.js JavaScript library</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class org.brophy.js.util.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.codify">codify</a></b>(The)
								</div>
								<div class="description">Codify all elements of the given class name.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.getLeft">getLeft</a></b>(e)
								</div>
								<div class="description">Get the left edge of an element (in pixels) relative to the left edge of the document.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.getRelativeLeft">getRelativeLeft</a></b>(e)
								</div>
								<div class="description">Get the left edge of an element (in pixels) relative to the left edge of the current viewport.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.getRelativeTop">getRelativeTop</a></b>(e)
								</div>
								<div class="description">Get the top edge of an element (in pixels) relative to the top edge of the current viewport.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.getScrollX">getScrollX</a></b>()
								</div>
								<div class="description">Get the number of pixels scrolled horizontally</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.getScrollY">getScrollY</a></b>()
								</div>
								<div class="description">Get the number of pixels scrolled horizontally</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.getTop">getTop</a></b>(e)
								</div>
								<div class="description">Get the top edge of an element (in pixels) relative to the top edge of the document.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.getWindowHeight">getWindowHeight</a></b>()
								</div>
								<div class="description">Get the width of the current window</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.getWindowWidth">getWindowWidth</a></b>()
								</div>
								<div class="description">Get the width of the current window</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.toggleDisplay">toggleDisplay</a></b>(elemOrId, fancy, duration)
								</div>
								<div class="description">Toggle the display of an HTML element on the page.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.trim">trim</a></b>(str)
								</div>
								<div class="description">Remove leading and trailing spaces from a string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.triml">triml</a></b>(str)
								</div>
								<div class="description">Remove leading spaces from a string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">org.brophy.js.util.<b><a href="../symbols/org.brophy.js.util.html#.trimr">trimr</a></b>(str)
								</div>
								<div class="description">Remove trailing spaces from a string.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont">
						<b>org.brophy.js.util</b>
				</div>
				
				<div class="description">
					Utilities namespace in the org.brophy.js JavaScript library
					
				</div>
				
				
				
				
					
					
					
					
					
					
						<dl class="detailList">
						<dt class="heading">Requires:</dt>
						
							<dd>This library requires the <a href="http://www.mochikit.com">             MochiKit</a> JavaScript library              (version 1.4+).</dd>
						
						</dl>
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".codify"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">org.brophy.js.util.</span><b>codify</b>(The)
					
					</div>
					<div class="description">
						Codify all elements of the given class name.  This is meant to be called on page load on a DIV or P element with this class name.  IT will set the background colors of different lines to alternating colors and add lines numbers.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>The</b>
									
								</dt>
								<dd>classname of the elements to be codified</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>none</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getLeft"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{integer}</span>
					<span class="light">org.brophy.js.util.</span><b>getLeft</b>(e)
					
					</div>
					<div class="description">
						Get the left edge of an element (in pixels) relative to the left edge of the document.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>e</b>
									
								</dt>
								<dd>The element in question</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The number of pixels from the left edge of the document          to the left edge of the element.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getRelativeLeft"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{integer}</span>
					<span class="light">org.brophy.js.util.</span><b>getRelativeLeft</b>(e)
					
					</div>
					<div class="description">
						Get the left edge of an element (in pixels) relative to the left edge of the current viewport.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>e</b>
									
								</dt>
								<dd>The element in question</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The number of pixels from the left edge of the viewport          to the left edge of the element.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getRelativeTop"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{integer}</span>
					<span class="light">org.brophy.js.util.</span><b>getRelativeTop</b>(e)
					
					</div>
					<div class="description">
						Get the top edge of an element (in pixels) relative to the top edge of the current viewport.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>e</b>
									
								</dt>
								<dd>The element in question</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The number of pixels from the top edge of the viewport          to the top edge of the element.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getScrollX"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{integer}</span>
					<span class="light">org.brophy.js.util.</span><b>getScrollX</b>()
					
					</div>
					<div class="description">
						Get the number of pixels scrolled horizontally
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The number of pixels scrolled right</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getScrollY"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{integer}</span>
					<span class="light">org.brophy.js.util.</span><b>getScrollY</b>()
					
					</div>
					<div class="description">
						Get the number of pixels scrolled horizontally
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The number of pixels scrolled right</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getTop"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{integer}</span>
					<span class="light">org.brophy.js.util.</span><b>getTop</b>(e)
					
					</div>
					<div class="description">
						Get the top edge of an element (in pixels) relative to the top edge of the document.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>e</b>
									
								</dt>
								<dd>The element in question</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The number of pixels from the top edge of the document          to the top edge of the element.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getWindowHeight"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{integer}</span>
					<span class="light">org.brophy.js.util.</span><b>getWindowHeight</b>()
					
					</div>
					<div class="description">
						Get the width of the current window
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The width of the current window in pixels</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getWindowWidth"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{integer}</span>
					<span class="light">org.brophy.js.util.</span><b>getWindowWidth</b>()
					
					</div>
					<div class="description">
						Get the width of the current window
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The width of the current window in pixels</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".toggleDisplay"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{boolean}</span>
					<span class="light">org.brophy.js.util.</span><b>toggleDisplay</b>(elemOrId, fancy, duration)
					
					</div>
					<div class="description">
						Toggle the display of an HTML element on the page.  This is done by toggling the presence of a css class, which contains a 'display:none;' rule
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>elemOrId</b>
									
								</dt>
								<dd>Either the element to hide/show, or the ID of an element on the         page.  If this parameter is a string, the element will be         looked up with getElementById().</dd>
							
								<dt>
									<b>fancy</b>
									<i>Optional, Default:  false</i>
								</dt>
								<dd>Optional boolean parameter on whether use MochiKit.Visual         effects to hide the element in a more vidsually epealling way</dd>
							
								<dt>
									<b>duration</b>
									<i>Optional, Default:  0.5</i>
								</dt>
								<dd>Optional duraiton of the effect if the 'fancy; parameter is         TRUE.  Defaults to 0.5 seconds.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>TRUE if the Element is found and the display is toggled,         FALSE otherwise.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".trim"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">org.brophy.js.util.</span><b>trim</b>(str)
					
					</div>
					<div class="description">
						Remove leading and trailing spaces from a string.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>str</b>
									
								</dt>
								<dd>The string to trim</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The trimmed string</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".triml"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">org.brophy.js.util.</span><b>triml</b>(str)
					
					</div>
					<div class="description">
						Remove leading spaces from a string.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>str</b>
									
								</dt>
								<dd>The string to trim</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The trimmed string</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".trimr"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">org.brophy.js.util.</span><b>trimr</b>(str)
					
					</div>
					<div class="description">
						Remove trailing spaces from a string.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>str</b>
									
								</dt>
								<dd>The string to trim</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The trimmed string</dd>
							
							</dl>
						
						
						

					
				
			
			
			<hr />
		</div>
		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.0.2 on Sun Aug 02 2009 20:49:02 GMT-0400 (EDT)
		</div>
	</body>
</html>
